<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>buffers_prefix</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="Chapter 1. Boost.Beast">
<link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
<link rel="prev" href="boost__beast__buffers_range_ref.html" title="buffers_range_ref">
<link rel="next" href="boost__beast__buffers_front.html" title="buffers_front">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__beast__buffers_range_ref.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__buffers_front.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="beast.ref.boost__beast__buffers_prefix"></a><a class="link" href="boost__beast__buffers_prefix.html" title="buffers_prefix">buffers_prefix</a>
</h4></div></div></div>
<p>
        <a class="indexterm" name="idm73474"></a>
      </p>
<p>
        Returns a prefix of a constant or mutable buffer sequence.
      </p>
<h5>
<a name="beast.ref.boost__beast__buffers_prefix.h0"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__buffers_prefix.synopsis"></a></span><a class="link" href="boost__beast__buffers_prefix.html#beast.ref.boost__beast__buffers_prefix.synopsis">Synopsis</a>
      </h5>
<p>
        Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/core/buffers_prefix.hpp" target="_top">boost/beast/core/buffers_prefix.hpp</a>&gt;</code>
      </p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">class</span> <a class="link" href="../concepts/BufferSequence.html" title="BufferSequence"><span class="emphasis"><em>BufferSequence</em></span></a><span class="special">&gt;</span>
<span class="identifier">buffers_prefix_view</span><span class="special">&lt;</span> <span class="identifier">BufferSequence</span> <span class="special">&gt;</span>
<span class="identifier">buffers_prefix</span><span class="special">(</span>
    <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">size</span><span class="special">,</span>
    <span class="identifier">BufferSequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">);</span>
</pre>
<h5>
<a name="beast.ref.boost__beast__buffers_prefix.h1"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__buffers_prefix.description"></a></span><a class="link" href="boost__beast__buffers_prefix.html#beast.ref.boost__beast__buffers_prefix.description">Description</a>
      </h5>
<p>
        The returned buffer sequence points to the same memory as the passed buffer
        sequence, but with a size that is equal to or smaller. No memory allocations
        are performed; the resulting sequence is calculated as a lazy range.
      </p>
<h5>
<a name="beast.ref.boost__beast__buffers_prefix.h2"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__buffers_prefix.parameters"></a></span><a class="link" href="boost__beast__buffers_prefix.html#beast.ref.boost__beast__buffers_prefix.parameters">Parameters</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <code class="computeroutput"><span class="identifier">size</span></code>
                </p>
              </td>
<td>
                <p>
                  The maximum size of the returned buffer sequence in bytes. If this
                  is greater than or equal to the size of the passed buffer sequence,
                  the result will have the same size as the original buffer sequence.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="computeroutput"><span class="identifier">buffers</span></code>
                </p>
              </td>
<td>
                <p>
                  An object whose type meets the requirements of <span class="emphasis"><em>BufferSequence</em></span>.
                  The returned value will maintain a copy of the passed buffers for
                  its lifetime; however, ownership of the underlying memory is not
                  transferred.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="beast.ref.boost__beast__buffers_prefix.h3"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__buffers_prefix.return_value"></a></span><a class="link" href="boost__beast__buffers_prefix.html#beast.ref.boost__beast__buffers_prefix.return_value">Return
        Value</a>
      </h5>
<p>
        A constant buffer sequence that represents the prefix of the original buffer
        sequence. If the original buffer sequence also meets the requirements of
        <span class="emphasis"><em>MutableBufferSequence</em></span>, then the returned value will
        also be a mutable buffer sequence.
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
      Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__beast__buffers_range_ref.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__buffers_front.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
